<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>IDA SDK: cli_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">IDA SDK
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="files.html"><span>Header&#160;Files</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structcli__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cli_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Command line interpreter. </p>
<p>Provides functionality for the command line (located at the bottom of the main window). Only GUI version of IDA supports CLIs. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7ed831a1cead17c6cb05da342e96a81f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ed831a1cead17c6cb05da342e96a81f"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a7ed831a1cead17c6cb05da342e96a81f">size</a></td></tr>
<tr class="memdesc:a7ed831a1cead17c6cb05da342e96a81f"><td class="mdescLeft">&#160;</td><td class="mdescRight">size of this structure <br /></td></tr>
<tr class="separator:a7ed831a1cead17c6cb05da342e96a81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20701884f205ee79d132073da60777ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20701884f205ee79d132073da60777ca"></a>
<a class="el" href="pro_8h.html#a56f1a81c92849566ae864511088eb7e8">int32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a20701884f205ee79d132073da60777ca">flags</a></td></tr>
<tr class="memdesc:a20701884f205ee79d132073da60777ca"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group___c_l_i_f__.html">CLI attributes</a> <br /></td></tr>
<tr class="separator:a20701884f205ee79d132073da60777ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f3146833c9d903792033840ec374f6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f3146833c9d903792033840ec374f6c"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a5f3146833c9d903792033840ec374f6c">sname</a></td></tr>
<tr class="memdesc:a5f3146833c9d903792033840ec374f6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">short name (displayed on the button) <br /></td></tr>
<tr class="separator:a5f3146833c9d903792033840ec374f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47d58e37ea034d8f30dd3dd975d6ee2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47d58e37ea034d8f30dd3dd975d6ee2e"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a47d58e37ea034d8f30dd3dd975d6ee2e">lname</a></td></tr>
<tr class="memdesc:a47d58e37ea034d8f30dd3dd975d6ee2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">long name (displayed in the menu) <br /></td></tr>
<tr class="separator:a47d58e37ea034d8f30dd3dd975d6ee2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d1326e0885bc0b369d38d446d497910"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d1326e0885bc0b369d38d446d497910"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a8d1326e0885bc0b369d38d446d497910">hint</a></td></tr>
<tr class="memdesc:a8d1326e0885bc0b369d38d446d497910"><td class="mdescLeft">&#160;</td><td class="mdescRight">hint for the input line <br /></td></tr>
<tr class="separator:a8d1326e0885bc0b369d38d446d497910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5ff09b640ffb0644be756b812761f4a"><td class="memItemLeft" align="right" valign="top">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#aa5ff09b640ffb0644be756b812761f4a">execute_line</a> )(const char *line)</td></tr>
<tr class="memdesc:aa5ff09b640ffb0644be756b812761f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback: the user pressed Enter.  <a href="#aa5ff09b640ffb0644be756b812761f4a">More...</a><br /></td></tr>
<tr class="separator:aa5ff09b640ffb0644be756b812761f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70ed34707e60d2e958baceb7c2a60018"><td class="memItemLeft" align="right" valign="top">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a70ed34707e60d2e958baceb7c2a60018">complete_line</a> )(<a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *completion, const char *prefix, int n, const char *line, int x)</td></tr>
<tr class="memdesc:a70ed34707e60d2e958baceb7c2a60018"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback: the user pressed Tab.  <a href="#a70ed34707e60d2e958baceb7c2a60018">More...</a><br /></td></tr>
<tr class="separator:a70ed34707e60d2e958baceb7c2a60018"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74f002fcb7ca09b2bfc1429d4a574997"><td class="memItemLeft" align="right" valign="top">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcli__t.html#a74f002fcb7ca09b2bfc1429d4a574997">keydown</a> )(<a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *line, int *p_x, int *p_sellen, int *p_vk_key, int shift)</td></tr>
<tr class="memdesc:a74f002fcb7ca09b2bfc1429d4a574997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback: a keyboard key has been pressed.  <a href="#a74f002fcb7ca09b2bfc1429d4a574997">More...</a><br /></td></tr>
<tr class="separator:a74f002fcb7ca09b2bfc1429d4a574997"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa5ff09b640ffb0644be756b812761f4a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * cli_t::execute_line) (const char *line)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback: the user pressed Enter. </p>
<p>CLI is free to execute the line immediately or ask for more lines. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">line</td><td>command to execute (utf-8-encoded) </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>executed line </td></tr>
    <tr><td class="paramname">false</td><td>ask for more lines </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a70ed34707e60d2e958baceb7c2a60018"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * cli_t::complete_line) (<a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *completion, const char *prefix, int n, const char *line, int x)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback: the user pressed Tab. </p>
<p>This callback is optional. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">completion</td><td>result of completion </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">prefix</td><td>text to complete </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">n</td><td>completion number </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">line</td><td>entire command line, given as context information </td></tr>
    <tr><td class="paramdir"></td><td class="paramname">x</td><td>index where 'prefix' starts in 'line' </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>generated a new completion </td></tr>
    <tr><td class="paramname">false</td><td>otherwise </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a74f002fcb7ca09b2bfc1429d4a574997"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool(<a class="el" href="pro_8h.html#a6505e7ff3b129d8b17258304886fd133">idaapi</a> * cli_t::keydown) (<a class="el" href="pro_8h.html#a386c10c6aa4340f1d63df85f40454fce">qstring</a> *line, int *p_x, int *p_sellen, int *p_vk_key, int shift)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback: a keyboard key has been pressed. </p>
<p>This callback is optional. It is a generic callback and the CLI is free to do whatever it wants. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">line</td><td>current input line (in/out argument) </td></tr>
    <tr><td class="paramname">p_x</td><td>pointer to current x coordinate of the cursor (in/out) </td></tr>
    <tr><td class="paramname">p_sellen</td><td>pointer to current selection length (usually 0) </td></tr>
    <tr><td class="paramname">p_vk_key</td><td>pointer to virtual key code (in/out). if the key has been handled, it should be reset to 0 by CLI </td></tr>
    <tr><td class="paramname">shift</td><td>shift state </td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>modified input line or x coordinate or selection length </td></tr>
    <tr><td class="paramname">false</td><td>otherwise </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="kernwin_8hpp.html">kernwin.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
